DocuSign actions

1. About DocuSign Auth:

To retrieve access token and refresh token using Authorization Code Grant.

To use this connetctor you need to setup the app in your DocuSign account with the redirect URI as : {YOUR_RUNTIME_URL}/services/api/docusign/auth.

Before you can make any API calls using Authorization Code Grant, you must get your user’s consent for your app to act for them.To get this consent, open the accompanying example URI in your embedded browser https://account-d.docusign.com/oauth/auth?response_type=code&scope=YOUR_REQUESTED_SCOPES&client_id=YOUR_INTEGRATION_KEY&state=YOUR_CUSTOM_STATE&redirect_uri=YOUR_REDIRECT_URI

Properties:

Following are the properties of this connector and can be overridden by global context.

1. Host_Environment

Your DocuSign Host Environment. override property docusign_credentials.host_env_url

2. Integration_Key

Your DocuSign Integration key. override property docusign_credentials.integration_key

3. Secret_Key

Your DocuSign Secret key. override property docusign_credentials.secret_key

Following message properties can be inside the connector properties if provided.

global.get('docusign_credentials.host_env_url') => Host_Environment
global.get('docusign_credentials.integration_key') => Integration_Key
global.get('docusign_credentials.secret_key') => Secret_Key

The connector will store your access token and refresh token in following global properties

Access Token : docusign_credentials.access_token Refresh Token : docusign_credentials.access_token

For more information about DocuSign API please visit here DocuSign API Documentation.

2. About DocuSign Create Conect Configuration:

To create a custom connect configuration for the specified account.

Properties:

Following are the properties of this connector and can be overridden by msg.config object.

1. Base_Url

Your DocuSign Base URL. override property msg.config.baseUrl

2. API_version

Your DocuSIgn API Version. override property msg.config.apiVersion

3. Account_Id

Your external account number (int) or account ID GUID. Override property msg.config.accountId

4. Access_Token

Your authorization access token. override property msg.config.accessToken

5. Data_Property

List of signers to whom you want to resend the envelope. (check msg.model format below)

Following message properties can be inside the connector properties if provided.

msg.config.baseUrl => Base_Url
msg.config.apiVersion => API_version
msg.config.accountId => Account_Id
msg.config.accessToken => Access_Token

Sample config

msg.config ={
    baseUrl: "" ,
    apiVersion: "" ,
    accountId: "",
    envelopeId: "",
    environment: "",
    accessToken: "" 
}

Sample msg.model

msg.data ={
 "configurationType": "custom",
 "urlToPublishTo": "YOUR-WEBHOOK-URL",
 "allUsers": "true",
 "name": "jsonSimTest",
 "deliveryMode": "SIM",
 "allowEnvelopePublish": "true",
 "enableLog": "true",
 "eventData": {
  "version": "restv2.1"
 },
 "events": [
  "demo event 1",
  "demo event 2"
 ]
}

For more information about DocuSign API please visit here DocuSign API Documentation.

3. About DocuSign Create Envelope:

To create and send an envelope.

Properties:

Following are the properties of this connector and can be overridden by msg.config object.

1. Base_Url

Your DocuSign Base URL. override property msg.config.baseUrl

2. API_version

Your DocuSIgn API Version. override property msg.config.apiVersion

3. Account_Id

Your external account number (int) or account ID GUID. Override property msg.config.accountId

4. Access_Token

Your authorization access token. override property msg.config.accessToken

5. Data_Property

List of signers to whom you want to resend the envelope. (check msg.model format below)

Following message properties can be inside the connector properties if provided.

msg.config.baseUrl => Base_Url
msg.config.apiVersion => API_version
msg.config.accountId => Account_Id
msg.config.accessToken => Access_Token

Sample config

msg.config ={
    baseUrl: "" ,
    apiVersion: "" ,
    accountId: "",
    accessToken: "" 
}

Sample msg.model

msg.data ={
    "documents": [{
        "documentBase64": "demo base 64 of document",
        "documentId": "demo document id",
        "fileExtension": "demo document file extension",
        "name": 'demo document name'
    }],
    "emailBlurb" : "demo document email body/blurb",
    "emailSubject": "demo document subject",
    "recipients": {
       "signers": [{
         "email": "demo document signer email",
         "name": "demo document signer name",
         "recipientId": "demo document recipient id"
        }],
    },
    "status": "sent"
}

For more information about DocuSign API please visit here DocuSign API Documentation.

4. About DocuSIgn Download Documents :

To download the documents uploaded in an envelope.

Properties:

Following are the properties of this connector and can be overridden by msg.config object.

1. Base_Url

Your DocuSign Base URL. override property msg.config.baseUrl

2. API_version

Your DocuSIgn API Version. override property msg.config.apiVersion

3. Account_Id

Your external account number (int) or account ID GUID. Override property msg.config.accountId

4. Access_Token

Your authorization access token. override property msg.config.accessToken

5. Document_Id

Your document Id for which you want to retrieve the document details. Override property msg.config.documentId

6. Envelope_Id

Your envelope ID associated with the document. Override property msg.config.envelopeId

7. Encoding_Type

Encoding type you want to return for the document. Override property msg.config.encodingType

Following message properties can be inside the connector properties if provided.

msg.config.baseUrl => Base_Url
msg.config.apiVersion => API_version
msg.config.accountId => Account_Id
msg.config.accessToken => Access_Token
msg.config.documentId => Document_Id
msg.config.envelopeId => Envelope_Id
msg.config.encodingType => Encoding_Type

Sample config

msg.config ={
    baseUrl: "" ,
    apiVersion: "" ,
    accountId: "",
    accessToken: "",
    documentId: "",
    envelopeId: "",
    encodingType: ""
}

For more information about DocuSign API please visit here DocuSign API Documentation.

5. About DocuSign Get Documents List:

To get the list of documents uploaded in an envelope.

Properties:

Following are the properties of this connector and can be overridden by msg.config object.

1. Base_Url

Your DocuSign Base URL. override property msg.config.baseUrl

2. API_version

Your DocuSIgn API Version. override property msg.config.apiVersion

3. Account_Id

Your external account number (int) or account ID GUID. Override property msg.config.accountId

4. Access_Token

Your authorization access token. override property msg.config.accessToken

5. Envelope_Id

Your envelope ID GUID. Override property msg.config.envelopeId

Following message properties can be inside the connector properties if provided.

msg.config.baseUrl => Base_Url
msg.config.apiVersion => API_version
msg.config.accountId => Account_Id
msg.config.accessToken => Access_Token
msg.config.envelopeId => Envelope_Id

Sample config

msg.config ={
    baseUrl: "" ,
    apiVersion: "" ,
    accountId: "",
    accessToken: "",
    envelopeId: "" 
}

For more information about DocuSign API please visit here DocuSign API Documentation.

6. About DocuSign Get Envelope Status:

To retrieve the overall status for the specified envelope.

Properties:

Following are the properties of this connector and can be overridden by msg.config object.

1. Base_Url

Your DocuSign Base URL. override property msg.config.baseUrl

2. API_version

Your DocuSIgn API Version. override property msg.config.apiVersion

3. Account_Id

Your external account number (int) or account ID GUID. Override property msg.config.accountId

4. Envelope_Id

Your envelope's GUID for which you want to list the recipients. override property msg.config.envelopeId

5. Access_Token

Your authorization access token. override property msg.config.accessToken

Following message properties can be inside the connector properties if provided.

msg.config.baseUrl => Base_Url
msg.config.apiVersion => API_version
msg.config.accountId => Account_Id
msg.config.envelopeId => Envelope_Id
msg.config.accessToken => Access_Token

Sample config

msg.config ={
    baseUrl: "" ,
    apiVersion: "" ,
    accountId: "",
    envelopeId: "",
    accessToken: "" 
}

For more information about DocuSign API please visit here DocuSign API Documentation.

7. About DocuSign Get Recipient List:

To retrieve the status of all recipients in a single envelope and identifies the current recipient in the routing list.

Properties:

Following are the properties of this connector and can be overridden by msg.config object.

1. Base_Url

Your DocuSign Base URL. override property msg.config.baseUrl

2. API_version

Your DocuSIgn API Version. override property msg.config.apiVersion

3. Account_Id

Your external account number (int) or account ID GUID. Override property msg.config.accountId

4. Envelope_Id

Your envelope's GUID for which you want to list the recipients. override property msg.config.envelopeId

5. Access_Token

Your authorization access token. override property msg.config.accessToken

Following message properties can be inside the connector properties if provided.

msg.config.baseUrl => Base_Url
msg.config.apiVersion => API_version
msg.config.accountId => Account_Id
msg.config.envelopeId => Envelope_Id
msg.config.accessToken => Access_Token

Sample config

msg.config ={
    baseUrl: "" ,
    apiVersion: "" ,
    accountId: "",
    envelopeId: "",
    accessToken: "" 
}

For more information about DocuSign API please visit here DocuSign API Documentation.

8. About DocuSign Resend Envelope:

To resend an envelope to a recipient.

Properties:

Following are the properties of this connector and can be overridden by msg.config object.

1. Base_Url

Your DocuSign Base URL. override property msg.config.baseUrl

2. API_version

Your DocuSIgn API Version. override property msg.config.apiVersion

3. Account_Id

Your external account number (int) or account ID GUID. Override property msg.config.accountId

4. Envelope_Id

Your envelope's GUID for which you want to list the recipients. override property msg.config.envelopeId

5. Access_Token

Your authorization access token. override property msg.config.accessToken

6. Data_Property

List of signers to whom you want to resend the envelope. (check msg.model format below)

Following message properties can be inside the connector properties if provided.

msg.config.baseUrl => Base_Url
msg.config.apiVersion => API_version
msg.config.accountId => Account_Id
msg.config.envelopeId => Envelope_Id
msg.config.accessToken => Access_Token

Sample config

msg.config ={
    baseUrl: "" ,
    apiVersion: "" ,
    accountId: "",
    envelopeId: "",
    environment: "",
    accessToken: "" 
}

Sample msg.model

msg.data ={
    "signers": [
      {
        "recipientId": "77",
        "name": "Demo",
        "email": "bhanuja2001@gmail.com"
       }
    ]
}

For more information about DocuSign API please visit here DocuSign API Documentation.

1. About DocuSign Auth:​

Properties:​

1. Host_Environment​

2. Integration_Key​

3. Secret_Key​

2. About DocuSign Create Conect Configuration:​

Properties:​

1. Base_Url​

2. API_version​

3. Account_Id​

4. Access_Token​

5. Data_Property​

3. About DocuSign Create Envelope:​

Properties:​

1. Base_Url​

2. API_version​

3. Account_Id​

4. Access_Token​

5. Data_Property​

4. About DocuSIgn Download Documents :​

Properties:​

1. Base_Url​

2. API_version​

3. Account_Id​

4. Access_Token​

5. Document_Id​

6. Envelope_Id​

7. Encoding_Type​

5. About DocuSign Get Documents List:​

Properties:​

1. Base_Url​

2. API_version​

3. Account_Id​

4. Access_Token​

5. Envelope_Id​

6. About DocuSign Get Envelope Status:​

Properties:​

1. Base_Url​

2. API_version​

3. Account_Id​

4. Envelope_Id​

5. Access_Token​

7. About DocuSign Get Recipient List:​

Properties:​

1. Base_Url​

2. API_version​

3. Account_Id​

4. Envelope_Id​

5. Access_Token​

8. About DocuSign Resend Envelope:​

Properties:​

1. Base_Url​

2. API_version​

3. Account_Id​

4. Envelope_Id​

5. Access_Token​

6. Data_Property​

1. About DocuSign Auth:

Properties:

1. Host_Environment

2. Integration_Key

3. Secret_Key

2. About DocuSign Create Conect Configuration:

Properties:

1. Base_Url

2. API_version

3. Account_Id

4. Access_Token

5. Data_Property

3. About DocuSign Create Envelope:

Properties:

1. Base_Url

2. API_version

3. Account_Id

4. Access_Token

5. Data_Property

4. About DocuSIgn Download Documents :

Properties:

1. Base_Url

2. API_version

3. Account_Id

4. Access_Token

5. Document_Id

6. Envelope_Id

7. Encoding_Type

5. About DocuSign Get Documents List:

Properties:

1. Base_Url

2. API_version

3. Account_Id

4. Access_Token

5. Envelope_Id

6. About DocuSign Get Envelope Status:

Properties:

1. Base_Url

2. API_version

3. Account_Id

4. Envelope_Id

5. Access_Token

7. About DocuSign Get Recipient List:

Properties:

1. Base_Url

2. API_version

3. Account_Id

4. Envelope_Id

5. Access_Token

8. About DocuSign Resend Envelope:

Properties:

1. Base_Url

2. API_version

3. Account_Id

4. Envelope_Id

5. Access_Token

6. Data_Property